cboj-payments-prc-api

Description:

This API fetches the tracking details for the transfers created using either an FT reference or as customer ID as an input.

Mulesoft Request:

Headers:

Mandatory Headers: x-channel-id,x-client-trace-id, x-bank-id,client_id, client_secret

Optional Headers: x-sub-channel-id,x-user-id, Authorization, x-debug-flag, x-customer-id

Paramaters:

URI Params: NA

Query Params: searchType , searchString

Content-type: application/json

Body:

NA

Mulesoft Response:

Success Response: (200)

{
    "paymentDetails": {
        "currentStatus": "ACSP/G001",
        "statusDescription": {
            "en": "GB#ACSP/G001",
            "ar": "AR#ACSP/G001"
        },
        "statusDate": "24/11/2019",
        "statusTime": "09:10:35",
        "statusOriginator": "EFBKJOAMXXX",
        "bicDescription": "CAPITAL BANK OF JORDAN",
        "paymentAmount": "323.750",
        "paymentCurrency": "JOD",
        "deductAmount": "3.000",
        "deductCurrency": "JOD",
        "paymentWith": "ISLAMIC INTERNATIONAL ARAB BANK"
    },
    "status": {
        "success": true,
        "code": "200",
        "arabicMessage": "تمت العملية بنجاح",
        "englishMessage": "The Operation has been Successfully Completed"
    }
}

Sample Error Response:

Please refer the HOME page for all possible combinations of error response codes.

Note: The 'errorCode' and 'backendErrorMessage' will be in the error response message only if 'x-debug-flag' is '1'

404 :

{
    "status": {
        "success": false,
        "code": "T24003799",
        "reasonCode": "",
        "arabicMessage": "NO SIGN ON NAME SUPPLIED DURING SIGN ON PROCESS",
        "englishMessage": "NO SIGN ON NAME SUPPLIED DURING SIGN ON PROCESS",
        "errorCode": "T24003799",
        "errorDescription": "INVALID/ NO SIGN ON NAME SUPPLIED DURING SIGN ON PROCESS"
    }
}